package io.cici.cc.mybatis.plus.annotation;

import io.cici.cc.mybatis.lite.type.TypeHandler;

import java.lang.annotation.*;

/**
 * 表字段标识
 */
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.FIELD, ElementType.ANNOTATION_TYPE})
public @interface Column {

    String value();

    String type();


    /**
     * 字段 where 实体查询比较条件
     * <p>
     * 默认 {@link SqlCondition#EQUAL}
     */
    String condition() default "";

    /**
     * 字段 update set 部分注入, 该注解优于 el 注解使用
     * <p>
     * 例1：@TableField(.. , update="%s+1") 其中 %s 会填充为字段 输出 SQL 为：update 表 set 字段=字段+1
     * where ...
     * <p>
     * 例2：@TableField(.. , update="now()") 使用数据库时间 输出 SQL 为：update 表 set 字段=now()
     * where ...
     */
    String update() default "";

    /**
     * 字段验证策略之 insert: 当insert操作时，该字段拼接insert语句时的策略
     * <p>
     * IGNORED: 直接拼接 insert into table_a(column) values (#{columnProperty});
     * NOT_NULL: insert into table_a(<if test="columnProperty != null">column</if>)
     * values (<if test="columnProperty != null">#{columnProperty}</if>) NOT_EMPTY:
     * insert into
     * table_a(<if test="columnProperty != null and columnProperty!=''">column</if>)
     * values (<if test="columnProperty != null and
     * columnProperty!=''">#{columnProperty}</if>) NOT_EMPTY 如果针对的是非 CharSequence
     * 类型的字段则效果等于 NOT_NULL
     *
     * @since 3.1.2
     */
    FieldStrategy insertStrategy() default FieldStrategy.DEFAULT;

    /**
     * 字段验证策略之 update: 当更新操作时，该字段拼接set语句时的策略
     * <p>
     * IGNORED: 直接拼接 update table_a set column=#{columnProperty},
     * 属性为null/空string都会被set进去 NOT_NULL: update table_a set
     * <if test="columnProperty != null">column=#{columnProperty}</if> NOT_EMPTY:
     * update table_a set <if test="columnProperty != null and
     * columnProperty!=''">column=#{columnProperty}</if> NOT_EMPTY 如果针对的是非
     * CharSequence 类型的字段则效果等于 NOT_NULL
     *
     * @since 3.1.2
     */
    FieldStrategy updateStrategy() default FieldStrategy.DEFAULT;

    /**
     * 字段验证策略之 where: 表示该字段在拼接where条件时的策略
     * <p>
     * IGNORED: 直接拼接 column=#{columnProperty} NOT_NULL:
     * <if test="columnProperty != null">column=#{columnProperty}</if> NOT_EMPTY:
     * <if test="columnProperty != null and
     * columnProperty!=''">column=#{columnProperty}</if> NOT_EMPTY 如果针对的是非
     * CharSequence 类型的字段则效果等于 NOT_NULL
     *
     * @since 3.1.2
     */
    FieldStrategy whereStrategy() default FieldStrategy.DEFAULT;

    /**
     * 是否进行 select 查询
     * <p>
     * 大字段可设置为 false 不加入 select 查询范围
     */
    boolean select() default true;

    /**
     * 是否保持使用全局的 columnFormat 的值
     * <p>
     * 只生效于 既设置了全局的 columnFormat 也设置了上面 {@link #value()} 的值 如果是 false , 全局的
     * columnFormat 不生效
     *
     * @since 3.1.1
     */
    boolean keepGlobalFormat() default false;

    /**
     * @since 3.4.4
     */
    String property() default "";


    /**
     * 类型处理器 (该默认值不代表会按照该值生效), 只生效于 mp 自动注入的 method, 建议配合
     * {@link Table#autoResultMap()} 一起使用
     */
    Class<? extends TypeHandler> typeHandler();


}
